Magnum One

home *** CD-ROM | disk | FTP | other *** search

/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d15 / fp10s.arc / FIDOPCB.DOC < prev next >

Wrap

Text File | 1992-01-04 | 26.4 KB | 633 lines

------------------------------------------------------- . OOOOOO oo OO OOOOOO OOOOOO OOOOO . Version: 1.0 . OO OO OO OO OO OO OO . Release: Jan 01 1992 . OOOO OO OOOOOO OOOOOO OOOOOO OO OOOOO . Author : Matjaz Koce . OO OO OO OO OO OO OO OO OO OO . . OO OO OOOOOO OOOOOO OO OOOOOO OOOOOO . (c) MicroArt d.o.o ------------------------------------------------------- 1991-92 . FidoPCB - FidoNet & PCBoard 14.x mail interface . ------------------------------------------------------- Lazy Sysop's rule: "Long manuals are never printed and read completely" -----=- Table of contents -=--------------------------------------- Naming Conventions --------------------------------------- 1 Distribution File ---------------------------------------- 2 Distribution Rules --------------------------------------- 2 Contacting the Author ------------------------------------ 2 Shareware ------------------------------------------------ 3 Unregistered Shareware version --------------------------- 3 Overview ------------------------------------------------- 3 Limitations ---------------------------------------------- 4 First installation steps --------------------------------- 4 Command line parameters ---------------------------------- 5 Configuration file --------------------------------------- 7 Lost Mail ------------------------------------------------ 10 Handling NetMail ----------------------------------------- 10 Areafix -------------------------------------------------- 11 Copyrights and Trademarks -------------------------------- 11 End ------------------------------------------------------ 11 -----=- Naming Conventions -=---------------------------------------------- FidoPCB is distributed using the filenaming convention of: FPvvb.aaa where 'vv' stands for version such as '13' for version 1.3, '50' for version 5.0. The 'b' refers to a letter code specifying (A)lpha, (B)eta, (R)egistered or (S)hareware release versions. So the registered release is distributed as FPvvR.aaa. The final AAA refers to the compression method of distribution file. This may be ARC, ZIP, ARJ or whatever. When referring to this distribution file in the documentation, it will usually be referred as to "ZIP file". FIDOPCB.DOC Page 2 -----=- Distribution File -=----------------------------------------------- The following files should be present within the distribution ZIP file: File Description =========== ======================================================== FIDOPCB.EXE The executable program FIDOPCB.DOC The documentation you are reading now HISTORY.DOC File describing changes from version to version FIDOPCB.CFG Sample (self describing) configuration file RUNFD.BAT Batch file used to run FrontDoor, PCBoard and FidoPCB LOST. PCBoard message base for lost mail LOST.NDX Index file for LOST. MATRIX. PCBoard message base for net mail MATRIX.NDX Index file for MATRIX. =========== ======================================================== Alpha/Beta versions usually do not include the .DOC files but instead include the HISTORY.DOC file for brief description of changes. Please be sure to read this file if you are working with an alpha or beta version of FidoPCB! -----=- Distribution Rules -=---------------------------------------------- Sysops MAY place 'ZIP Comments' on the RNet distribution ZIP file if they normally do such with all their download files. Sysops MAY place additional files (such as 'README.1ST' or 'BBS_AD') ONLY if file names don't conflict with files in distribution file (look previous paragraph). Distribution of the alpha, beta, and registered versions is restricted to those systems with specific permission to distribute such. Do not distribute any version of FidoPCB except the unregistered shareware (FPvvS.aaa) version! -----=- Contacting the Author -=------------------------------------------- Problems, questions, and suggestions should be directed to Matjaz Koce: Modem: MicroArt BBS Node 1: +38 66 34 986 [1200-9600] Node 2: +38 66 33 816 [1200-2400] Node 3: +38 66 37 536 [1200-2400] Mail: MicroArt d.o.o Matjaz Koce Pristaniska 5/I 66000 Koper Slovenija FIDOPCB.DOC Page 3 EchoMail: AdriaNet: Sysops, Shareware, HomeMadeSW EchoConferences. FidoNet: Echo_sys EchoConference NetMail: 2:380/100@FidoNet.org 2:333/606@FidoNet.org -----=- Shareware -=------------------------------------------------------- Since you have likely read statements under the heading "Shareware" often, I won't bother going into the idea again. Simply be aware that FidoPcb is shareware (30 USD$ or 50 DEM), the registered version has some additional features, and that the file REGISTER.DOC contains the shareware registration form and information. You can also send me Net Mail or leave comment to sysop on MicroArt BBS. Any and all registered users may download and operate any later 1.x registered and beta versions of MicroArt as desired. The registered and beta versions are always available from MicroArt BBS or other support BBS's. Registration will also give you access to BBS support conference named FidoPCB to share your experiences with other registered users. In this conference you can also make suggestions, report bugs (I hope this won't happen), and so on. -----=- Unregistered Shareware version -=---------------------------------- Running FidoPcb will show you wether you are using shareware [NR] or registered [Serial#] version. Unregistered version will accept maximum of 30 configured areas. Tear line will be also indicating that you are using '---FidoPcb [NR]'. There are no other limitations in unregistered version of FidoPcb. -----=- Overview -=-------------------------------------------------------- FidoPcb is an utility used to import/export FidoNet type messages into PCBoard message base. Messages are transferred between many different BBS's in so called FTS-2 type packet. FidoPcb does all work: - unpacks compressed packet (compression can be ZIP, ARC, ARJ, LHA) - imports PKT files containing messages for various AREAS (without conversion from PKT into MSG !!!) into PCBoard message base - exports new messages from PCBoard message base - packs exported messages - makes MSG file for FrontDoor (send file, hold file) - makes OUT file for BinkleyTerm FIDOPCB.DOC Page 4 - handles NetMail (private FidoNet mail) in both directions (in/out) - handles AreaFix commands (if you are host, they can automatically connect new areas) - works on networks and multinode PCBoard with file sharing All this and other features (not so important do write them into this DOC) can be used with multiple addresses (AKAs). -----=- Limitations -=--------------------------------------------------- As mentioned, the unregistered version will handle only 30 configured areas. Registered version, instead, will handle 1000 areas or more if explicitly desired from user. Using FILES=20 or more in CONFIG.SYS FidoPcb will be able to process mail for 10 configured nodes (if you are working as HUB or HOST). Next versions will have limitations depending on FILES and your available memory only. FidoPcb doesn't check how many disk space is available, so be sure, that there is at least 1 Mb free or more depending on packet sizes. Also there should be at least 300K of free RAM, mainly to run archivers like PKUNZIP... FidoPcb disadvantage is also the limited size of a message. It shouldn't exceed 32Kb. But how many messages are over 32Kb long!? Next versions will handle messages with unlimited size. -----=- First installation steps -=--------------------------------------- Within packet containing FidoPcb you received sample configuration file so I advice you to use it as an example. You should be also experienced user of PCBSETUP to install two additional conferences (Matrix and Lost Mail). They will be described later in this DOC. Also be sure you have put your directory containing various archivers (PKUNZIP, PKZIP, ARJ...) into jour search PATH. Installation is divided into this five steps (fourth is the longest :->): 1) create directory FIDOPCB 2) change current directory to newly created FIDOPCB 3) unzip FPvvb.ZIP : FIDOPCB.EXE - executive code FIDOPCB.CFG - sample configuration file FIDOPCB.DOC - this DOC file RUNFD.BAT - sample BAT file for FrontDoor MATRIX.* - message base an it's index LOST.* - message base an it's index 4) use text editor to edit configuration file FIDOPCB.CFG (lines should end with LF/CR. Don't use Tabs - chr(9)!) 4.1) the configuration file is 'self describing', you can read more about various parameters into this DOC; don't forget to setup all FIDOPCB.DOC Page 5 conferences you wrote into configuration file under AREA parameter; you must also go into PCBoard and join them, this would create MSGS and MSGS.NDX message bases 4.2) copy files LOST and LOST.NDX into directory described with parameter LOST_MAIL and setup this area in PCBoard as LOST_MAIL (this is not really necessary, but I recommend that) 4.3) copy files MATRIX and MATRIX.NDX into directory described with parameter NET_MAIL and setup this area in PCBoard as MATRIX or NET_MAIL (this is necessary!) 4.4) run FIDOPCB SET ALL TOP (this will report errors in your configuration if there are any and set all lastread pointers); if there are any errors, read step 4.2 again 4.5) select one area as 'test area' and write into some messages (do not use messages with *Origin line unless you are using FORCE parameter in command line!) 4.6) run FIDOPCB SET 'test area' -1 4.7) run FIDOPCB EXPORT 4.8) check the results in PACKET directory, MAIL directory and FIDOPCB.STA file, if not OK goto 4 5) include FIDOPCB in your BAT files for events If you are incapable to set up FidoPcb just mail me on my BBS. I'll be there to help you. -----=- Command line parameters -=---------------------------------------- Running FIDOPCB.EXE without parameters or with /? will display all command line parameters on the screen. FidoPcb needs only simple information on the command line to operate. Most of the information is read from the FIDOPCB.CFG file. Command line syntax: FIDOPCB [/?] [command] [area name & number] [switch] /? generates short description of all available commands and switches Command should be on of: EXPORT, IMPORT, TOSS, SET, LIST, STAT Switches are: FORCE, RESET, STRIP Commands: EXPORT - exports all new messages (since last execution of FIDOPCB), updates last read pointers IMPORT - looks for new mail packet files on directory FILES and imports them into PCBoard message base, updates last read pointers no matter if there were any messages to export TOSS - exports all new messages, look for new mail packet file on directory FILE, imports messages and updates last read pointers SET - syntax of the SET command is: SET AreaName/ALL Number/Top It sets last read pointer for specified area (AreaName) or FIDOPCB.DOC Page 6 all areas if you specify ALL instead of area name. Using parameter Top instead of Number will set last read message to highest (top of message base). You can use negative numbers to set last read pointers back from current value for specified Number of messages (the Number will be subtracted from the highest (top) message number). If the Number is above the highest message, the highest message number will be used. LIST - syntax of the LIST command is: LIST AreaName/ALL It lists last read pointers and areas type. Using ALL instead of AreaName will show you all areas. STAT - displays statistics of all inbound/outbound mail Switches: RESET - used with command STAT will reset statistic information to 0 STRIP - used with EXPORT, TOSS will convert all characters higher than chr(128) into '*' FORCE - used with EXPORT, TOSS will export messages even if they are containing 'Origin:' line (this 'Origin' line checking is used to avoid sending received messages) There are some samples how to use them: FIDOPCB LIST ALL = will list all areas (name, their lastread pointer and type) FIDOPCB STAT = will show import/export statistics FIDOPCB STAT RESET = will reset statistics for all areas to 0 FIDOPCB SET Net_Mail TOP = will set last read pointer in Matrix to top of the message base FIDOPCB SET ALL -10 = will set all areas last read pointers to (current pointer - 10) FIDOPCB SET FIDOTEST 1 = will set lastread pointer in area FIDOTEST to 1 FIDOPCB TOSS STRIP = will export all new messages into PKT files, look for MO?, TH?... and import them into PCBoard, route messages in PKT to other nodes as defined in FIDOPCB.CFG, all characters in messages from PCBoard greater than 'Ç' are FIDOPCB.DOC Page 7 changed into '*' FIDOPCB EXPORT FORCE = will export all new messages into PKT files. Messages with * Origin: line into body text, by default are not exported (to prevent duplicates). Option FORCE forces messages to be exported no matter they have Origin line or not FIDOPCB IMPORT = will look for MO?, TH?... and import them into PCBoard -----=- Configuration file -=--------------------------------------------- FIDOPCB.CFG is contains configuration for FidoPcb. Configuration file can and should be created with a standard text editor such as QEdit or even Edlin. Lines beginning with a semi-colon (";") will be ignored. Each keyword should be specified on a separate line and should have no tabs (chr(9)) between the keyword itself and parameters. Please see the example CFG file included in this ZIP file for a template to use. Please, don't leave blank lines to separate keywords, because they are ignored and when an error occurs, you'll get a wrong line number indicating this error. Use the semi-colon in such lines. Don't use word processors since they may put some additional information into simple ASCII text. Maximum line length is 512 characters. In a future version a configuration program will be included to ease the configuration process. Valid keywords are: ORIGIN, TAG, SYSOP, NODE, AREA, AREA_MSGS, MAIL, PACKET, WORK, FILE, COMPRESS, FLOW_TYPE, NET_MAIL, LOST_MAIL, AKA, AKA_TAG, USE_AKA, NET_TOSS, INTERFACE, NETWORK, IGNORE_ECHO Most of this keywords have their default values so it is not necessary to use all of them into configuration. Keyword are divided into four groups: directories descriptions, areas and node descriptions, strings, switches. Some of them are strictly connected: AREA_MSGS should follow AREA keyword SYSOP, COMPRESS, FLOW_TYPE, USE_AKA should follow NODE keyword AKA_TAG should follow AKA SYSOP should follow ORIGIN Directory descriptions: (existing!) directory name (max. 64 characters) Keyword Description ------------ ------------------------------------------------------------ FILE path to inbound packets (there are put received files) PACKET path to outbound packets (to sent them to other nodes) FIDOPCB.DOC Page 8 MAIL path to *.MSG (messages in Front Door) LOST_MAIL path to file LOST and LOST.NDX - message base to import lost mail (from 'not found' areas) NET_MAIL path to file MATRIX and MATRIX.NDX - message base for NetMail remember to put address of receiver in the first line of message when writing messages WORK needed to show FidoPCB work directory (use RAM disk if possible, but be sure to give it enough space) ------------ ------------------------------------------------------------ Example: MAIL c:\front\mail PACKET f:\microart\pcb\fidopcb\packet Switches: they can be ON, OFF, NO, YES, BOTH... First value in table is default value. Keyword Switches Description ------------ ----------- ------------------------------------------------- INTERFACE NONE FidoNet interface program you are using BINKLEY FRONTDOOR NET_TOSS PCBOARD where to process NetMail FRONTDOOR BOTH NETWORK OFF are you using multinode system (for file locking) ON IGNORE_ECHO ON export just messages marked ECHO or all no matter OFF of this flag COMPRESS ZIP compression methods of received/sent packets ARC ARJ LZH FLOWTYPE NORMAL what to do with exported packet: hold, send... HOLD IMMEDIATE CRASH ------------ ----------- ------------------------------------------------- Examples: INTERFACE frontdoor NETWORK off NET_TOSS both Strings: containing some ASCII data to describe TAGS, SYSOPS... Keyword Description ------------ ------------------------------------------------------------- ORIGIN your node main address (Z:RRR/NNN) TAG this string will be appended on the end of all messages sent under your main address AKA_TAG this string will be appended on the end of all messages sent under your AKA address FIDOPCB.DOC Page 9 SYSOP origin (used after ORIGIN) or other nodes sysop name (USED after NODE keyword) ------------ ------------------------------------------------------------- Example: ORIGIN 2:380/100 SYSOP Gregor Rudolf ; AKA 1 2:333/606 AKA_TAG We are the best in Koper,Slovenija (2:333/606) Areas and node description: multiple parameters in one line, they are also strictly connected with some other keywords (as explained before). Keyword Parameters Description Connection with ------------ ---------- ------------------------------ -------------------- AREA Number area number to connect with AREA_MSGS NODE parameter (from 1 to 127) Name area name exactly as in FidoNet areas listing Path path to PCBoard message base Type defining this area as pass trough (NOMAIL - messages are not written into message base) ------------ ---------- ------------------------------ -------------------- NODE Address address of node (Z:RRR/NNN) SYSOP, COMPRESS, Areas area numbers connected to this FLOW_TYPE, USE_AKA node (numbers should match AREA parameters!!!) ------------ ---------- ------------------------------ -------------------- AKA Number aka number to connect with AKA_TAG USE_AKA parameter (from 1 to 10) Address your aka address ------------ ---------- ------------------------------ -------------------- Example: AREA 1 Clipper d:\pcb\clipper AREA_MSGS Clip ; AREA 99 For_node_603 d:\pcb nomail ; NODE 2:333/603 1,99 SYSOP Pietro Budicin COMPRESS zip FLOW_TYPE hold -----=- Lost Mail -=------------------------------------------------------ LOST (and it's index LOST.NDX) is a PCBoard compatible message base containing mail from areas not defined in FIDOPCB.CFG. FIDOPCB.DOC Page 10 Occasionally look at it or set up it in PCBSETUP. This is one of indicators if your system is set up correctly on your side and on side of your HUB. Area names defined in FIDOPCB.CFG with parameter AREA are compared with names found into packet. If FidoPcb founds message with unknown area, puts this message into LOST message base. First line of all messages in LOST will contain AREA: AreaName, so you will be able to locate problem. -----=- Handling NetMail -=----------------------------------------------- MATRIX (and it's index MATRIX.NDX) is PCBoard compatible message base file. You should use it for Net Mail messages (private FidoNet messages). If you are using FrontDoor, FidoPcb scans for new MSG files and imports them into MATRIX conference in PCBoard. Compressed Net Mail messages are imported automatically without use of MSG files. When you are exporting Net Mail, you must write into first line of the message address of receiver's node using format (Z:RRR/NNN) where: Z = zone number (default is 2) R = region number N = node number. Don't forget brackets '(' and ')'. FidoPCB will check only this format. MATRIX messages are then transformed into MSG format used by Front Door, so you can review them. Their location is MAIL directory in FIDOPCB.CFG. They are routed by Front Door. To add special flags to message add line containing HOLD,IMM,CRASH in brackets. This command should be put in second line. Example: =================================================== To: ALL Date: 10.10.91 From: Gregor Rudolf Time: 12:13:11 Subj: Just sampling... Read: NO Conf: MATRIX (54) (2:380/101) <- receiver's address (IMM,CRASH) <- special flags This is only a sample message. ===================================================== If you are using NET_TOSS BOTH parameter into configuration file: don't use FM to read messages. This will generate duplicates in your MATRIX conference in PCBoard. I'm still looking for a solution to this unpleasant problem. First line of all received messages will have in the first line written FROM:(address). This will help you to see the sender's address and make your replies more easy. Messages in this conference will also FIDOPCB.DOC Page 11 have all ^a lines, containing some other info. -----=- Areafix -=-------------------------------------------------------- Areafix is active when you are working as HOST or HUB. This will allow all of your configured nodes to list, select and deselect available areas on your node with simple NetMail message. This message should be addressed to Areafix. "-q" into Subject of message will generate areas listing with marked all selected areas. If you put in message body text area name, this area will be selected. Adding '-' (minus) before area name will deselect area. Access to areafix is allowed only to configured nodes. Example: From: Matjaz Potrc, MojsteR BBS (2:380/101) To: Areafix, MicroArt BBS (2:380/100) Subj: -q ------------------------------------------- Clipper -C_Echo -Enet.soft -----=- Copyrights and Trademarks -=--------------------------------------- All programs mentioned are copyrighted and/or trademarked by their respective holders. Please refer to each respective program to determine the actual copyright/trademark holder as appropriate or needed. -----=- End -=------------------------------------------------------------ Thanks to: all beta testers (specially to Matjaz Potrc) Gregor Rudolf (who helped me with advices) Damjan Pavlovec (who made some correction on this DOC) Matjaz Potrc (who found some bugs in this DOC) Mosaic v1.0 (it's bugs made me feel bad so much that I decided to write a tosser on my own) Look in the file HISTORY.DOC to see changes from previous versions PLEASE, SUPPORT SHAREWARE! Thank you.